Integrating Frappe HR With Biometric Attendance Devices
Using biometric attendance devices in Frappe HR
Punch logs from a biometric system are only records of when an (employee arrives and leaves. They reveal the exact time the person gets to or leaves work.
Frappe HR has a feature that lets you save these logs in a document namedEmployee Checkin.
This makes sure that the attendance is recorded correctly and in one place
So, you can follow the steps below to link your biometric device (or any access control system that saves IN/OUT logs) to Frappe HR. These steps make sure that the process is working and following best practices and what ERPNext can do right now.
1. Setting up Auto Attendance to keep track of when employees clock in
You need to make sure that employees and their planned shifts are set up correctly before you can import or sync their check-in and check-out history into your Frappe HR system.
The Auto Attendance function in Frappe HR needs to know exactly when workers are scheduled to work so that it can figure out how many hours they worked and keep track of their attendance.
Check the official Auto Attendance setup guide: Set up Auto Attendance to get step-by-step directions.
You have:
You can make and change employee records with the Employee Master.
The Shift Assignment or Default Shift fields were used to give employees their shifts.
You can now move on to the following stage, which is to add the logs from the biometric device to the system.
to the process of checking in employees at Frappe HR ,You can enter punch logs into the Employee Checkin doctype of Frappe HR in several methods, depending on what the biometric system can perform.
Here are the suggested methods:
Method 1: Using the Data Import Tool
The quickest method to do this is to make an Excel or CSV report of your biometric device's check-in and check-out history and then use Frappe HR's built-in Data integrate Tool to routinely integrate these logs into the Employee Checkin document. Setting this up and keeping it going is easy.
This strategy works well for firms that don't need to integrate all the time or have tiny teams.
You can choose when to do manual imports: at the end of the day, week, or month.
For further information, see the official documentation, Data Import Tool
Step 2: Putting APIs together
- If you want a fully automated solution, you may use the API to connect your biometric system directly to Frappe HR.
This means that you don't have to do anything yourself, and your biometric data can sync with Frappe HR in real time or at a set time.
What to do:
To share access to an API in Frappe HR, make a separate user Such a user will be able to make Employee Checkin entries.
Create an API key and a secret for authentication.
For every employee record, make sure that the ID on your biometric device matches the ID on the Attendance Device (Biometric/RF Tag ID).
Use this endpoint:
Copy the Make file URL:/api/method/hrms.hr.doctype.employeecheckin.employeecheckin.addlogbasedonemployee_field
How to: Information about POST:
- employeefieldvalue: The biometric device's employee ID (Attendance Device ID).
- Enter the timestamp in the format "YYYY-MM-DD HH:MM:SS.000000."
8Device_id is an optional identifier for a location or device.
log_type (optional): The punch's direction, whether it's IN or OUT.
The optional skipautoattendance method lets you choose not to process auto-attendance (0/1).
employeefieldname: This field defaults to attendancedevice_id for matching employee records.
Latitude and longitude are optional coordinates that can be used in shifts that are depending on location.
The return is the Employee Checkin document that was made.
Method 3: Using ZKTeco or a similar device with a Python script This method only works with ZKTeco and other devices that use the ZKProtocol for TCP/IP connectivity.
At github:frappe/biometric-attendance-sync-tool, you can get the official open-source script
The script sends biometric logs from the device to Frappe HR using the API specified in Method
Most of the time, the computer that runs this script needs to be on the same LAN as the biometric device.
1. How do I pick a biometric device that works with Frappe HR?
If you use Method 1 or Method 2, any device that can output logs through an API or in a file format that is supported will work.
In order to use Method 3, your system must be able to use TCP/IP with the ZKProtocol.
Always ask the seller for a sample unit before you buy something to be sure it works.
2. What is the best way to choose an integration strategy?
Method 1: This is great for tiny manual installations or when you don't have access to an API.
Method 2: Great for syncing automatically from one or more places.
Method 3: This is great for installations where ZKTeco or similar devices are all in one place and the sync tool can work on the local network.